Show:

ia.ReportConfig Class

Defined in: ia\config\ReportConfig.js:1
Module: ia

Used to load and parse a config.xml file.

Constructor

ia.ReportConfig

(
  • source
)

Defined in ia\config\ReportConfig.js:1

Parameters:

  • source String

    The url for the config.xml file.

Methods

getButton

(
  • id
)
ia.ButtonConfig

Defined in ia\config\ReportConfig.js:199

Returns the button that corresponds to the id.

Parameters:

  • id String

    The id.

Returns:

ia.ButtonConfig: The button.

getButtons

() ia.ButtonConfig[]

Defined in ia\config\ReportConfig.js:191

Returns the buttons.

Returns:

ia.ButtonConfig[]: An array of buttons.

getComponent

(
  • id
)
ia.ComponentConfig | ia.TableConfig | ia.ButtonConfig | ia.TextConfig | ia.ImageConfig

Defined in ia\config\ReportConfig.js:159

Returns the widget that corresponds to the id.

Parameters:

  • id String

    The id.

Returns:

ia.ComponentConfig | ia.TableConfig | ia.ButtonConfig | ia.TextConfig | ia.ImageConfig: The widget.

getComponent

(
  • id
)
ia.ComponentConfig

Defined in ia\config\ReportConfig.js:182

Returns the component that corresponds to the id.

Parameters:

  • id String

    The id.

Returns:

ia.ComponentConfig: The component.

getComponents

() ia.ComponentConfig[]

Defined in ia\config\ReportConfig.js:174

Returns the components.

Returns:

ia.ComponentConfig[]: An array of components.

getImage

(
  • id
)
ia.ImageConfig

Defined in ia\config\ReportConfig.js:233

Returns the image that corresponds to the id.

Parameters:

  • id String

    The id.

Returns:

ia.ImageConfig: The image.

getImages

() ia.ImageConfig[]

Defined in ia\config\ReportConfig.js:225

Returns the images.

Returns:

ia.ImageConfig[]: An array of images.

getMapPalette

() ia.PaletteConfig

Defined in ia\config\ReportConfig.js:242

Returns the palette.

Returns:

ia.PaletteConfig: The palette object.

getProperties

() Associative Array

Defined in ia\config\ReportConfig.js:258

Returns the widgets properties.

Returns:

Associative Array: properties[propertyId] = property.

getProperty

(
  • id
)
Number | String

Defined in ia\config\ReportConfig.js:266

Gets the value for the property with the given id.

Parameters:

  • id String

    The property id.

Returns:

Number | String: The property value.

getText

(
  • id
)
ia.TextConfig

Defined in ia\config\ReportConfig.js:216

Returns the text that corresponds to the id.

Parameters:

  • id String

    The id.

Returns:

ia.TextConfig: The text.

getTexts

() ia.TextConfig[]

Defined in ia\config\ReportConfig.js:208

Returns the text.

Returns:

ia.TextConfig[]: An array of text.

getWidgets

() ia.ComponentConfig | ia.TableConfig | ia.ButtonConfig | ia.TextConfig | ia.ImageConfig[]

Defined in ia\config\ReportConfig.js:151

Returns all widgets in the config ie a concatenation of all components, tables, buttons, text and images.

Returns:

ia.ComponentConfig | ia.TableConfig | ia.ButtonConfig | ia.TextConfig | ia.ImageConfig[]: An array of widgets.

loadSource

(
  • url
  • callbackFunction
)

Defined in ia\config\ReportConfig.js:19

Loads in a source file containing the configuration xml.

Parameters:

  • url String

    The url to the data.

  • callbackFunction Function

    The call back function.

parseXML

(
  • xml
  • callbackFunction
)

Defined in ia\config\ReportConfig.js:40

Parses in an XML object containing the configuration xml.

Parameters:

  • xml XML

    The xml data.

  • callbackFunction Function

    The call back function.

setProperty

(
  • id
  • value
  • castValue
)

Defined in ia\config\ReportConfig.js:280

Sets the value for the property with the given id.

Parameters:

  • id String

    The property id.

  • value Number | String

    The property value.

  • castValue Boolean

    Indicates the value is a string and needs to be cast to the correct data type.

Properties

properties

Associative Array

Defined in ia\config\ReportConfig.js:250

The widgets properties, properties[propertyId] = property.

xml

XML

Defined in ia\config\ReportConfig.js:11

The raw xml data describing the object.